package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SocProgItemAddDTO;
import org.jsola.hr.dto.SocProgItemBatchDTO;
import org.jsola.hr.dto.SocProgItemUpdateDTO;
import org.jsola.hr.query.SocProgItemQuery;
import org.jsola.hr.vo.SocProgItemListVO;
import org.jsola.hr.vo.SocProgItemVO;

import java.util.List;

/**
 * 参保方案表子项
 *
 * @author zhr
 */
@Api(tags = "hr-参保方案表子项")
public interface ISocProgItemControllerAPI {

    /**
     * 新增参保方案表子项
     * @param socProgItemAddDTO 参保方案表子项新增实体
     * @return 参保方案表子项展示对象
     */
    @ApiOperation(value = "新增参保方案表子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemAddDTO", dataType = "SocProgItemAddDTO", value = "新增参保方案表子项", paramType = "body")
    })
    Result<SocProgItemVO> save(SocProgItemAddDTO socProgItemAddDTO);


    /**
     * 修改参保方案表子项
     * @param socProgItemUpdateDTO 参保方案表子项
     * @return 更新数量
     */
    @ApiOperation(value = "修改参保方案表子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemUpdateDTO", dataType = "SocProgItemUpdateDTO", value = "修改参保方案表子项", paramType = "body")
    })
    Result<Integer> update(SocProgItemUpdateDTO socProgItemUpdateDTO);

    /**
     * 批量编辑、新增、删除参保方案表子项
     * @param socProgItemBatchDTO 要操作的参保方案表子项
     * @return 操作之后的全部参保方案表子项
     */
    @ApiOperation(value = "批量编辑、新增、删除参保方案表子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemBatchDTO", dataType = "SocProgItemBatchDTO", value = "要操作的字段数据", paramType = "body")
    })
    Result batch(SocProgItemBatchDTO socProgItemBatchDTO);



    /**
     * 删除单个参保方案表子项，彻底删除
     * @param socProgItemId 参保方案表子项id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个参保方案表子项，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemId", dataType = "String", value = "参保方案表子项id", paramType = "path")
    })
    Result<Integer> delete(String socProgItemId);


    /**
     * 批量删除参保方案表子项，彻底删除
     * @param socProgItemIds 参保方案表子项id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除参保方案表子项，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemIds", dataType = "String[]", value = "参保方案表子项id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] socProgItemIds);


    /**
     * 根据参保方案表子项id查询参保方案表子项详情
     * @param socProgItemId 参保方案表子项id
     * @return 参保方案表子项详情
     */
    @ApiOperation(value="根据参保方案表子项id查询参保方案表子项详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemId", dataType = "String", value = "参保方案表子项id", paramType = "path")
    })
    Result<SocProgItemVO> findById(String socProgItemId);


    /**
     * 查询参保方案表子项
     * @param socProgItemQuery 参保方案表子项查询参数
     * @return page
     */
    @ApiOperation(value="查询参保方案表子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemQuery", dataType = "SocProgItemQuery", value = "参保方案表子项查询参数", paramType = "query")
    })
    Result<List<SocProgItemListVO>> listAll(SocProgItemQuery socProgItemQuery);


     /**
     * 分页查询参保方案表子项
     * @param socProgItemQuery 参保方案表子项查询参数
     * @return page
     */
    @ApiOperation(value="分页查询参保方案表子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socProgItemQuery", dataType = "SocProgItemQuery", value = "参保方案表子项查询参数", paramType = "query")
    })
    Result<Page<SocProgItemListVO>> page(SocProgItemQuery socProgItemQuery);


}

